home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / u_man / cat1 / X11 / xlock.z / xlock
Encoding:
Text File  |  2001-04-17  |  20.5 KB  |  397 lines

  1.  
  2.  
  3.  
  4.      XXXXLLLLOOOOCCCCKKKK((((1111))))               IIIIrrrriiiixxxx ((((00006666 JJJJuuuunnnn 1111999999991111))))                XXXXLLLLOOOOCCCCKKKK((((1111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           xlock - Locks the local X display until a password is
  10.           entered.
  11.  
  12.  
  13.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.           xxxxlllloooocccckkkk [ ----ddddiiiissssppppllllaaaayyyy dsp ] [ ----hhhheeeellllpppp ] [ ----nnnnaaaammmmeeee resource-name ]
  15.                 [ ----rrrreeeessssoooouuuurrrrcccceeeessss ] [ ----bbbbllllaaaannnnkkkktttthhhhrrrreeeesssshhhh num ] [ ----////++++rrrreeeemmmmooootttteeee ]
  16.                 [ ----////++++mmmmoooonnnnoooo ] [ ----////++++nnnnoooolllloooocccckkkk ] [ ----////++++aaaalllllllloooowwwwrrrrooooooootttt ]
  17.                 [ ----////++++bbbbeeeessssaaaavvvveeeerrrr ] [ ----////++++aaaalllllllloooowwwwaaaacccccccceeeessssssss ] [ ----////++++eeeecccchhhhooookkkkeeeeyyyyssss ]
  18.                 [ ----////++++vvvv ] [ ----////++++uuuusssseeeeffffiiiirrrrsssstttt ] [ ----ddddeeeellllaaaayyyy usecs  ]
  19.                 [ ----bbbbaaaattttcccchhhhccccoooouuuunnnntttt num  ] [ ----ccccoooolllloooorrrrccccoooouuuunnnntttt num  ]
  20.                 [ ----nnnniiiicccceeee level  ] [ ----ttttiiiimmmmeeeeoooouuuutttt seconds ]
  21.                 [ ----ssssaaaattttuuuurrrraaaattttiiiioooonnnn value  ] [ ----ffffoooonnnntttt fontname  ] [ ----bbbbgggg color
  22.                  ] [ ----ffffgggg color  ] [ ----mmmmooooddddeeee mode  ]
  23.                 [ ----uuuusssseeeerrrrnnnnaaaammmmeeee textstring  ] [ ----ppppaaaasssssssswwwwoooorrrrdddd textstring  ]
  24.                 [ ----iiiinnnnffffoooo textstring  ] [ ----vvvvaaaalllliiiiddddaaaatttteeee textstring  ]
  25.                 [ ----iiiinnnnvvvvaaaalllliiiidddd textstring  ]
  26.  
  27.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  28.           xxxxlllloooocccckkkk blanks (or otherwise saves) the  screen  and  possibly
  29.           locks  the  X  server till the user enters their password at
  30.           the keyboard.  While xxxxlllloooocccckkkk is has the screen locked, all new
  31.           server   connections  are  refused.   The  screen  saver  is
  32.           disabled.  The mouse cursor is turned off.   The  screen  is
  33.           blanked  and  a changing pattern is put on the screen.  If a
  34.           key or a mouse button is pressed then the user  is  prompted
  35.           for the password of the user who started xxxxlllloooocccckkkk....
  36.  
  37.           If the  correct  password  is  typed,  then  the  screen  is
  38.           unlocked  and  the  X  server  is restored.  When typing the
  39.           password Control-U and Control-H  are  active  as  kill  and
  40.           erase  respectively.   To return to the locked screen, click
  41.           in the small icon version of the changing pattern.
  42.  
  43.           If the screen is merely saved, but not  locked,  or  if  the
  44.           user  who started the program does not have a password, then
  45.           no password is required.
  46.  
  47.  
  48.      OOOOPPPPTTTTIIIIOOOONNNNSSSS
  49.           ----ddddiiiissssppppllllaaaayyyy  ddddsssspppp
  50.                The _d_i_s_p_l_a_y option sets the X11 display to lock.  xxxxlllloooocccckkkk
  51.                locks  all  available  screens  on  a given server, and
  52.                restricts you to locking only a local  server  such  as
  53.                uuuunnnniiiixxxx::::0000,,,,  llllooooccccaaaallllhhhhoooosssstttt::::0000,,,,  or ::::0000 unless you set the ----rrrreeeemmmmooootttteeee
  54.                option.
  55.  
  56.           ----nnnnaaaammmmeeee  rrrreeeessssoooouuuurrrrcccceeee----nnnnaaaammmmeeee
  57.                _r_e_s_o_u_r_c_e-_n_a_m_e is used instead of XXXXLLLLoooocccckkkk when looking for
  58.                resources to configure xlock.
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                                           (printed 4/6/01)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXLLLLOOOOCCCCKKKK((((1111))))               IIIIrrrriiiixxxx ((((00006666 JJJJuuuunnnn 1111999999991111))))                XXXXLLLLOOOOCCCCKKKK((((1111))))
  71.  
  72.  
  73.  
  74.           ----mmmmooooddddeeee  mmmmooooddddeeeennnnaaaammmmeeee
  75.                As  of  this  writing  there  are  ten  display   modes
  76.                supported (plus one more for random selection of one of
  77.                the ten).
  78.  
  79.           bbbbllllaaaannnnkkkk   Blank mode shows nothing but a black screen.
  80.  
  81.           rrrroooottttoooorrrr   Rotor mode shows a swirling rotorlike thing.
  82.  
  83.           ppppyyyyrrrroooo    Pyro mode shows lots of small fireworks.
  84.  
  85.           ffffllllaaaammmmeeee   Flame  mode  shows  wierd  but  cool  cosmic   flame
  86.                   fractals.
  87.  
  88.           hhhhoooopppp     Hop mode shows the "real plane  fractals"  from  the
  89.                   September 1986 issue of Scientific American.
  90.  
  91.           iiiimmmmaaaaggggeeee   Image  mode  shows  several   sgi   logos   randomly
  92.                   appearing on the screen.
  93.  
  94.           lllliiiiffffeeee    Life mode shows Conway's game of life.
  95.  
  96.           ppppoooopppp     Pop mode shows single large fireworks  exploding  on
  97.                   the screen.
  98.  
  99.           qqqqiiiixxxx     Qix mode shows the spinning lines similar to the old
  100.                   video game by the same name.
  101.  
  102.           sssswwwwaaaarrrrmmmm   Swarm mode shows a swarm of bees following a wasp.
  103.  
  104.           rrrraaaannnnddddoooommmm  Selects one of the above modes randomly.
  105.  
  106.  
  107.           ----ddddeeeellllaaaayyyy  uuuusssseeeeccccssss
  108.                The _d_e_l_a_y option sets the speed at which  a  mode  will
  109.                operate.   It simply sets the number of microseconds to
  110.                delay  between  batches  of  "hopalong  pixels",   "qix
  111.                lines",  "life generations", "image blits", and "pop or
  112.                swarm motions".  In blank mode, it is important to  set
  113.                this  to  some  small  number  of  seconds, because the
  114.                keyboard and mouse are only checked after  each  delay,
  115.                so  you  cannot  set the delay too high, but a delay of
  116.                zero would needlessly consume cpu  checking  for  mouse
  117.                and  keyboard  input  in a tight loop, since blank mode
  118.                has no work to do.
  119.  
  120.           ----bbbbaaaattttcccchhhhccccoooouuuunnnntttt  nnnnuuuummmm
  121.                The _b_a_t_c_h_c_o_u_n_t option sets the number of _t_h_i_n_g_s  to  do
  122.                per  batch  to  _n_u_m  .  In  qix mode this refers to the
  123.                number of lines rendered in the same  color.   In  life
  124.                mode  it  is  the  number  of  generations  to let each
  125.                species live.  In hop mode this refers to the number of
  126.  
  127.  
  128.  
  129.      Page 2                                           (printed 4/6/01)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXLLLLOOOOCCCCKKKK((((1111))))               IIIIrrrriiiixxxx ((((00006666 JJJJuuuunnnn 1111999999991111))))                XXXXLLLLOOOOCCCCKKKK((((1111))))
  137.  
  138.  
  139.  
  140.                pixels  rendered in the same color.  In image mode this
  141.                refers to the number of sgilogos on screen at once.  In
  142.                swarm mode this refers to the number of bees.  In rotor
  143.                mode it is the number of rotor thingys  which  whirr...
  144.                In pyro mode it is the maximum number flying rockets at
  145.                one time.  In flame mode it is the number of levels  to
  146.                recurse (larger = more complex).  In pop mode this sets
  147.                the maximum number of sparks in  a  burst  (the  actual
  148.                number  of sparts in any one burst is chosen randomly).
  149.                In blank mode it means nothing.
  150.  
  151.           ----ccccoooolllloooorrrrccccoooouuuunnnntttt  nnnnuuuummmm
  152.                The _c_o_l_o_r_c_o_u_n_t option sets the number of colors to  use
  153.                to _n_u_m .
  154.  
  155.           ----nnnniiiicccceeee  nnnniiiicccceeeelllleeeevvvveeeellll
  156.                The _n_i_c_e option sets  system  nicelevel  of  the  xlock
  157.                process to _n_i_c_e_l_e_v_e_l .
  158.  
  159.           ----ttttiiiimmmmeeeeoooouuuutttt  sssseeeeccccoooonnnnddddssss
  160.                The _t_i_m_e_o_u_t option sets the number  of  _s_e_c_o_n_d_s  before
  161.                the password screen will time out.
  162.  
  163.           ----ssssaaaattttuuuurrrraaaattttiiiioooonnnn  vvvvaaaalllluuuueeee
  164.                The _s_a_t_u_r_a_t_i_o_n option sets saturation of the color ramp
  165.                used  to  _v_a_l_u_e  .  0  is  grayscale and 1 is very rich
  166.                color.  0.4 is a nice pastel.
  167.  
  168.           ----ffffoooonnnntttt  ffffoooonnnnttttnnnnaaaammmmeeee
  169.                The _f_o_n_t option sets the font to be used on the  prompt
  170.                screen.
  171.  
  172.           ----ffffgggg  ccccoooolllloooorrrr
  173.                The _f_g option  sets  the  color  of  the  text  on  the
  174.                password screen to _c_o_l_o_r .
  175.  
  176.           ----bbbbgggg  ccccoooolllloooorrrr
  177.                The _b_g option sets the color of the background  on  the
  178.                password screen to _c_o_l_o_r .
  179.  
  180.           ----uuuusssseeeerrrrnnnnaaaammmmeeee  tttteeeexxxxttttssssttttrrrriiiinnnngggg
  181.                _t_e_x_t_s_t_r_i_n_g is shown in front of user name, defaults  to
  182.                "Name: ".
  183.  
  184.           ----ppppaaaasssssssswwwwoooorrrrdddd  tttteeeexxxxttttssssttttrrrriiiinnnngggg
  185.                _t_e_x_t_s_t_r_i_n_g is the password prompt string,  defaults  to
  186.                "Password: ".
  187.  
  188.           ----iiiinnnnffffoooo  tttteeeexxxxttttssssttttrrrriiiinnnngggg
  189.                _t_e_x_t_s_t_r_i_n_g is an informational message to tell the user
  190.                what  to  do,  defaults  to  "Enter password to unlock;
  191.                select icon to lock.".
  192.  
  193.  
  194.  
  195.      Page 3                                           (printed 4/6/01)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      XXXXLLLLOOOOCCCCKKKK((((1111))))               IIIIrrrriiiixxxx ((((00006666 JJJJuuuunnnn 1111999999991111))))                XXXXLLLLOOOOCCCCKKKK((((1111))))
  203.  
  204.  
  205.  
  206.           ----vvvvaaaalllliiiiddddaaaatttteeee _t_e_x_t_s_t_r_i_n_g
  207.                _t_e_x_t_s_t_r_i_n_g ----vvvvaaaalllliiiiddddaaaatttteeee _m_e_s_s_a_g_e _s_h_o_w_n _w_h_i_l_e _v_a_l_i_d_a_t_i_n_g _t_h_e
  208.                _p_a_s_s_w_o_r_d, _d_e_f_a_u_l_t_s _t_o "Validating login..."
  209.  
  210.           ----iiiinnnnvvvvaaaalllliiiidddd _t_e_x_t_s_t_r_i_n_g
  211.                _t_e_x_t_s_t_r_i_n_g ----iiiinnnnvvvvaaaalllliiiidddd  _m_e_s_s_a_g_e  _s_h_o_w_n  _w_h_e_n  _p_a_s_s_w_o_r_d  _i_s
  212.                _i_n_v_a_l_i_d, _d_e_f_a_u_l_t_s _t_o "Invalid login."
  213.  
  214.  
  215.           ----rrrreeeessssoooouuuurrrrcccceeeessss
  216.                The _r_e_s_o_u_r_c_e_s option prints the default  resource  file
  217.                for xlock to standard output.
  218.  
  219.           ----////++++rrrreeeemmmmooootttteeee
  220.                The _r_e_m_o_t_e option tells xlock  to  not  stop  you  from
  221.                locking remote X11 servers.  This option should be used
  222.                with care and is intended mainly to lock X11  terminals
  223.                which  cannot  run  _x_l_o_c_k locally.  If you lock someone
  224.                else's  workstation,  they  will  have  to  know   yyyyoooouuuurrrr
  225.                password to unlock it.
  226.  
  227.           ----////++++mmmmoooonnnnoooo
  228.                The _m_o_n_o option causes  xlock  to  display  monochrome,
  229.                (black  and  white)  pixels  rather  than  the  default
  230.                colored ones on color displays
  231.  
  232.           ----////++++nnnnoooolllloooocccckkkk
  233.                The  _n_o_l_o_c_k  option  causes  xlock  to  only  draw  the
  234.                patterns  and  not  lock  the display.  A keypress or a
  235.                mouse click will terminate the screen saver or send  it
  236.                back into the background (with ----bbbbeeeessssaaaavvvveeeerrrr).
  237.  
  238.           ----////++++aaaalllllllloooowwwwrrrrooooooootttt
  239.                The _a_l_l_o_w_r_o_o_t option allows the root password to unlock
  240.                the server as well as the user who started xlock.
  241.  
  242.           ----////++++eeeennnnaaaabbbblllleeeessssaaaavvvveeeerrrr
  243.                By default xlock will disable  the  normal  X  server's
  244.                screen  saver  since  it is in effect a replacement for
  245.                it.  Since it is possible to set delay parameters  long
  246.                enough  to  cause  phosphor burn on some displays, this
  247.                option will turn back on the default screensaver  which
  248.                is very careful to keep most of the screen black.
  249.  
  250.           ----////++++bbbbeeeessssaaaavvvveeeerrrr
  251.                If your X server supports  the  SCREEN-SAVER  protocol,
  252.                then  this  option will tell xlock to act as the screen
  253.                saver.  When you use xlock in this mode,  it  will  not
  254.                lock  the screen immediately.  Instead, when the server
  255.                decides the screen should be blanked,  it  will  notify
  256.                xlock  instead  of  merely  blanking the screen.  Xlock
  257.                will  then  display  whatever  display  mode  you  have
  258.  
  259.  
  260.  
  261.      Page 4                                           (printed 4/6/01)
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.      XXXXLLLLOOOOCCCCKKKK((((1111))))               IIIIrrrriiiixxxx ((((00006666 JJJJuuuunnnn 1111999999991111))))                XXXXLLLLOOOOCCCCKKKK((((1111))))
  269.  
  270.  
  271.  
  272.                selected.
  273.  
  274.                In this mode, xlock will not exit when you  type  in  a
  275.                password.   Instead,  its window will disappear, and it
  276.                will wait for the next screen saver time out.
  277.  
  278.                This option forces ----eeeennnnaaaabbbblllleeeessssaaaavvvveeeerrrr....
  279.  
  280.           ----bbbbllllaaaannnnkkkktttthhhhrrrreeeesssshhhh _n_u_m
  281.                Whenever xlock is displaying some graphic mode and  the
  282.                system load rises over this value, xlock will switch to
  283.                blank mode.  Since blank mode is  much  less  expensive
  284.                than  many  of  the graphic modes, this will allow time
  285.                for other system activity.
  286.  
  287.           ----////++++aaaalllllllloooowwwwaaaacccccccceeeessssssss
  288.                This option is required for servers which do not  allow
  289.                clients  to modify the host access control list.  It is
  290.                also useful if you need to run x clients  on  a  server
  291.                which is locked for some reason...  When allowaccess is
  292.                true, the X11 server is left open for clients to attach
  293.                and   thus   lowers   the  inherent  security  of  this
  294.                lockscreen.  A side effect of using this option is that
  295.                if  xlock  is  killed -KILL, the access control list is
  296.                not lost.
  297.  
  298.           ----////++++eeeecccchhhhooookkkkeeeeyyyyssss
  299.                The _e_c_h_o_k_e_y_s option causes xlock to echo '?' characters
  300.                for  each  key  typed  into  the password prompt.  Some
  301.                consider this a security risk, so the default is to not
  302.                echo anything.
  303.  
  304.           ----////++++uuuusssseeeeffffiiiirrrrsssstttt
  305.                The _u_s_e_f_i_r_s_t option causes xlock to use  the  keystroke
  306.                which  got  you  to  the  password  screen as the first
  307.                character in the password.  The default  is  to  ignore
  308.                the first key pressed.
  309.  
  310.           ----vvvv   Verbose mode, tells what options it is going to use.
  311.  
  312.  
  313.      BBBBUUUUGGGGSSSS
  314.           "kill -KILL xxxxlllloooocccckkkk " causes the server that was locked to  be
  315.           unusable, since all hosts (including localhost) were removed
  316.           from the access control list to lock out new X clients,  and
  317.           since  xlock  couldn't  catch  SIGKILL, it terminated before
  318.           restoring the access control list.  This will  leave  the  X
  319.           server  in  a state where "_y_o_u _c_a_n _n_o _l_o_n_g_e_r _c_o_n_n_e_c_t _t_o _t_h_a_t
  320.           _s_e_r_v_e_r, _a_n_d _t_h_i_s _o_p_e_r_a_t_i_o_n _c_a_n_n_o_t  _b_e  _r_e_v_e_r_s_e_d  _u_n_l_e_s_s  _y_o_u
  321.           _r_e_s_e_t   _t_h_e   _s_e_r_v_e_r."              -From   the  X11R4  Xlib
  322.           Documentation, Chapter 7.
  323.  
  324.  
  325.  
  326.  
  327.      Page 5                                           (printed 4/6/01)
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.      XXXXLLLLOOOOCCCCKKKK((((1111))))               IIIIrrrriiiixxxx ((((00006666 JJJJuuuunnnn 1111999999991111))))                XXXXLLLLOOOOCCCCKKKK((((1111))))
  335.  
  336.  
  337.  
  338.           On some kernel and  hardware  combinations,  ppppoooopppp  mode  will
  339.           cause trashy flickering at the top of the screen.  This is a
  340.           bug in the graphics  library/kernel/hardware  (depending  on
  341.           how you look at it) and is out of xxxxlllloooocccckkkk's control.
  342.  
  343.      NNNNOOOOTTTTEEEE
  344.           If you run xxxxlllloooocccckkkk on a machine  not  running  the  kernel  in
  345.           /unix,  you  can potentially confuse xxxxlllloooocccckkkk since it will not
  346.           be able to measure the load correctly.  If the load  appears
  347.           too  far  out  of  range, xxxxlllloooocccckkkk will print a message to that
  348.           affect and disable the load threshold checking.
  349.  
  350.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  351.           X(1), xset(1), Xlib Documentation.
  352.  
  353.      AAAAUUUUTTTTHHHHOOOORRRR
  354.            Patrick J. Naughton      (naughton@eng.sun.com)
  355.            Mailstop 10-20
  356.            Sun Laboratories, Inc.
  357.            Mountain View, CA  94043
  358.            415/336-1080
  359.  
  360.  
  361.      CCCCOOOOPPPPYYYYRRRRIIIIGGGGHHHHTTTT
  362.           Copyright (c) 1988-91 by Patrick J. Naughton
  363.  
  364.           Permission  to  use,  copy,  modify,  and  distribute   this
  365.           software  and  its documentation for any purpose and without
  366.           fee is hereby granted, provided  that  the  above  copyright
  367.           notice  appear  in  all  copies and that both that copyright
  368.           notice and  this  permission  notice  appear  in  supporting
  369.           documentation.
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.      Page 6                                           (printed 4/6/01)
  394.  
  395.  
  396.  
  397.